The CygNet measurement system contains several categories and types of validation rules. Rules are assigned to validation engines, where they comprise a set of checks against the data for a single associated Node. Each rule can be configured to automatically detect potential problems in your data, according to its configured limits and guidelines. The system processes normalized data for validation rules as it applies to the given data type. Data will be validated by device rules first, and then all other applicable rules will follow.
When configuring rule properties, you can name or rename the rule as desired. If you do not assign a rule name, it will retain the default rule name based on the rule type, as listed in the tables below. Multiple rules in a validation engine can have the same name, although you may want to assign unique names upon rule creation to more easily identify them. See Configuring Validation Rules for more information.
Validation rules are organized into the following categories, based on affected data types. For each category, available rule types are listed in the corresponding tables below.
See Managing Validation Engines for information about defining validation engines and their associated Nodes.
The following table lists the available validation rule types for devices, and each rule's configuration options.
| Rule Type | Default Rule Name | Description | Configuration Options |
|---|---|---|---|
|
Time Synchronization |
Time Synch |
The system will validate that the time reported from the device is within the specified tolerance. Records failing validation will generate an exception marked with the current system time, not the Device time (D). |
Specify the Severity, Data quality, and a Begin and End time for the time window. |
The following table lists the available validation rule types for a single configuration record, and each rule's configuration options.
The following table lists the available validation rule types for imported gas analysis data, and each rule's configuration options. These rules will be validated against Nodes that support gas analysis data.
| Rule Type | Default Rule Name | Description | Configuration Options |
|---|---|---|---|
|
Source Consistency Check |
Source Consistency |
The system will validate that the source of the gas analysis sample is consistent with the source configured in the associated Node properties. Records failing validation will generate an exception. |
Specify the Severity |
|
Sum of gas composition |
Gas Comp Sum |
The system will validate that the gas composition total adds up to 100% within the specified tolerance. Records failing validation will generate an exception. |
Specify the Severity, a +/- range for the tolerance, and Units to use (% or fraction) |
|
Change Limit... validation rules: The system will validate the value of the HVV to determine if it has changed from the value in the previous gas analysis record and, if so, if the change is within the specified tolerance; otherwise the value will be considered to be an "out of range" value. |
|||
|
Change Limit - HVV (As Delivered) |
Limit HVV As Del |
The system will validate that a change in Heating Value Volume (As delivered) from the previous gas analysis record is within the specified tolerance. |
Specify the Severity, a +/- range for the tolerance, and Units to use (% or fraction) |
|
Change Limit - HVV (Dry) |
Limit HVV Dry |
The system will validate that a change in Heating Value Volume (Dry) from the previous gas analysis record is within the specified tolerance. |
Specify the Severity, a +/- range for the tolerance, and Units to use (% or fraction) |
|
Change Limit - HVV (Wet) |
Limit HVV Wet |
The system will validate that a change in Heating Value Volume (Wet) from the previous gas analysis record is within the specified tolerance. |
Specify the Severity, a +/- range for the tolerance, and Units to use (% or fraction) |
|
High/Low Limits... validation rules: The system will validate the value of the selected gas analysis data item, to determine if its value is within the high/low range specified; otherwise the value will be considered out of range and will trigger the exception process. |
|||
|
High/Low Limits - Gas Analysis Relative Density |
Limit GA Rel Densit |
The system will validate that data values of the selected type are within the specified range. Records failing validation are considered "high" or "low" values and will generate an exception. |
Specify the Severity, and a Low and High value for the limits |
|
High/Low Limits - Sample Base Pressure |
Sample BP |
Specify the Severity, a Low and High value for the limits, and Units to use (from the options in the drop-down menu) |
|
|
High/Low Limits - Sample Base Temperature |
Sample BT |
Specify the Severity, a Low and High value for the limits, and Units to use (from the options in the drop-down menu) |
|
|
High/Low Limits - Total Liquid Content |
Limit Total Liquid |
Specify the Severity, a Low and High value for the limits, and Units to use (from the options in the drop-down menu) |
|
|
High/Low Limits - Methane |
Limit Methane |
Specify the Severity, a Low and High value for the limits, and Units to use (% or fraction) |
|
|
High/Low Limits - Ethane |
Limit Ethane |
||
|
High/Low Limits - Propane |
Limit Propane |
||
|
High/Low Limits - n-Butane |
Limit n-Butane |
||
|
High/Low Limits - Isobutane |
Limit Isobutane |
||
|
High/Low Limits - n-Pentane |
Limit n-Pentane |
||
|
High/Low Limits - Isopentane |
Limit Isopentane |
||
|
High/Low Limits - n-Hexane |
Limit n-Hexane |
||
|
High/Low Limits - n-Heptane |
Limit n-Heptane |
||
|
High/Low Limits - n-Octane |
Limit n-Octane |
||
|
High/Low Limits - n-Nonane |
Limit n-Nonane |
||
|
High/Low Limits - n-Decane |
Limit n-Decane |
||
|
High/Low Limits - Carbon dioxide |
Limit Carbon Dioxid |
||
|
High/Low Limits - Helium |
Limit Helium |
||
|
High/Low Limits - Hydrogen Sulfide |
Limit Hydrogen Sulf |
||
|
High/Low Limits - Nitrogen |
Limit Nitrogen |
||
|
High/Low Limits - Oxygen |
Limit Oxygen |
||
The following table lists the available validation rule types for gas metering history data, and each rule's configuration options.
|
Rule Type |
Default Rule Name |
Description |
Configuration Options |
|---|---|---|---|
|
Alarm Set State |
Alarm Set State |
The system will validate whether a device is in an alarm state for the specified period. Records failing validation will generate an exception. Note: If an exception is generated when polling the same hourly record for multiple history records, the original exception will be resolved automatically. If records from a new data poll fail validation, new exceptions will be generated. |
Specify the Severity, and Data quality |
|
High/Low Flow... Cutoff Range validation rules: The system will validate that the field devices are operating within the high/low flow range specified; otherwise the value will be considered out of range and will trigger the exception process. |
|||
|
High/Low Flow Diff Pressure Cutoff Range |
Cutoff Flow DP |
The system will validate that data values of the selected type are within the specified flow cutoff range. Records failing validation are considered "high flow" or "low flow" values, outside the cutoff range, and will generate an exception. Note: Differential Pressure or Pulse values of null or zero (0) will not trigger exceptions. |
Specify the Severity, Data quality, a Low and High value for the cutoff range, and Units to use |
|
High/Low Flow Pulses Cutoff Range |
Cutoff Flow Pulses |
||
|
High/Low Flow Rate Cutoff Range |
Cutoff Flow Rate |
||
|
Low Flow... Cutoff Limit validation rules: The system will validate that the field devices are operating above the low flow limit specified; otherwise the value will be considered out of range and will trigger the exception process. |
|||
|
Low Flow Diff Pressure Cutoff Limit |
Cutoff Low Flow DP |
The system will validate that data value (diff pressure) of the device is above the specified limit. Records failing validation are considered "low flow" values, below the cutoff limit, and will generate an exception. Note: Differential Pressure values of null or zero (0) will not trigger exceptions. |
Specify the Severity, Data quality, a Cutoff value for the cutoff limit, and Units to use |
|
High/Low Operational Limit... validation rules: The system will validate that field devices are operating within the high/low operational limits specified; otherwise the value will be considered out of range and will trigger the exception process. |
|||
|
High/Low Operational Limit - Diff Pressure |
Op Limit DP |
The system will validate that data values of the selected type are within the specified operational limits. Records failing validation are considered "high" or "low" values, outside the operational limits, and will generate an exception. Note: Differential Pressure values of null or zero (0) will not trigger exceptions. |
Specify the Severity, Data quality, a Low and High value for the limits, and Units to use |
|
High/Low Operational Limit - Static Pressure |
Op Limit SP |
||
|
High/Low Operational Limit - Temperature |
Op Limit Temp |
||
|
High/Low Reasonability... validation rules: The system will validate that field devices are operating within the high/low reasonability limits specified; otherwise the value will be considered out of range and will trigger the exception process. |
|||
|
High/Low Reasonability - Diff Pressure |
Reas DP |
The system will validate that data values of the selected type are within the specified engineering reasonability limits. Records failing validation are considered "high" or "low" values, outside the reasonability limits, and will generate an exception. Note: Differential Pressure values of null or zero (0) will not trigger exceptions. |
Specify the Severity, Data quality, a Low and High value for the limits, and Units to use |
|
High/Low Reasonability - Flow Time (Absolute) |
Reas Flow Time Abs |
||
|
High/Low Reasonability - Flow Time (Percentage) |
Reas Flow Time Pct |
||
|
High/Low Reasonability - Static Pressure |
Reas SP |
||
|
High/Low Reasonability - Temperature |
Reas Temp |
||
|
Report Calculation Warning |
Rpt Calc Warning |
If warnings occur when the system performs a calculation, an exception will be generated. |
Specify the Severity, and Data quality |
|
Report Recalculation Failure |
Rpt Recalc Failure |
If errors occur when the system performs a recalculation, an exception will be generated. |
|
|
VCF Frac |
The system will validate that the volume calculations are correct within the specified tolerance (fraction or percentage - as specified). Records failing validation will generate an exception. Note: Whether an exception is generated or not, the percentage of the recalculated volume vs. the device volume will be stored in the gas metering record. This value will be stored as VCF (Volume Correction Factor) and is calculated by dividing the recalculated volume by the device volume. Use this VCF value to quickly see how far off the recalculated volume was from the device volume. It is also used for recalculation when user edit are made per API 21.1. |
Specify the Severity, Data quality, and a +/- fractional range for the tolerance |
|
|
Volume Correction Factor (Percentage) |
VCF Pct |
Specify the Severity, Data quality, and a +/- percentage range for the tolerance |
|
The following table lists the available validation rule types for gas quality data from live history records, and each rule's configuration options. These rules will be validated against live gas history data on Nodes that support gas quality data.
|
Rule Type |
Default Rule Name |
Description |
Configuration Options |
|---|---|---|---|
|
Gas Composition Normalization |
Gas Comp Norm |
The system will validate that the gas composition adds up to 100% within the specified tolerance. Records failing validation will generate an exception. |
Specify the Severity, Data quality, and a +/- percentage range for the tolerance |
|
Sum of CO2, N2 |
Sum of CO2, N2 |
The system will validate that the sum of the CO2 and N2 components are within the specified tolerance. Records failing validation will generate an exception. |
Specify the Severity, Data quality, and a Low and High percentage value for the tolerance |
|
Sum of iC5, nC5, C6 |
Sum of iC5, nC5, C6 |
The system will validate that the sum of the iC5, nC5, and C6 components are within the specified tolerance. Records failing validation will generate an exception. |
Specify the Severity, Data quality, and a Low and High percentage value for the tolerance |
The following table lists the available validation rule types for previously retrieved (historical) multiple gas quality or gas metering data records, and each rule's configuration options.
|
Rule Type |
Default Rule Name |
Description |
Configuration Options |
|---|---|---|---|
|
Average... validation rules: The system will validate that the device field data does not deviate outside historical averages for a specified period of time. |
|||
|
Average Diff Pressure (Absolute) |
Avg DP Abs |
The system will validate that the reported data does not go outside an absolute range of historical averages for a previous period of time. Records failing validation will generate an exception. Note: Differential Pressure values of null or zero (0) will not trigger exceptions. |
Specify the Severity, Data quality, a +/- absolute range, the # of records to consider, and Units to use See Notes below. |
|
Average Energy (Absolute) |
Avg Energy Abs |
||
|
Average Mass (Absolute) |
Avg Mass Abs |
||
|
Average Static Pressure (Absolute) |
Avg SP Abs |
||
|
Average Temperature (Absolute) |
Avg Temp Abs |
||
|
Average Volume (Absolute) |
Avg Vol Abs |
||
|
Average Diff Pressure (Percentage) |
Avg DP Pct |
The system will validate that the reported data does not go outside a percentage range of historical averages for a previous period of time. Records failing validation will generate an exception. Note: Differential Pressure values of null or zero (0) will not trigger exceptions. |
Specify the Severity, Data quality, a +/- percentage range, and the # of records to consider See Notes below. |
|
Average Energy (Percentage) |
Avg Energy Pct |
||
|
Average Mass (Percentage) |
Abs Mass Pct |
||
|
Average Static Pressure (Percentage) |
Avg SP Pct |
||
|
Average Temperature (Percentage) |
Avg Temp Pct |
||
|
Average Volume (Percentage) |
Avg Vol Pct |
||
|
Minimum Average Diff Pressure (Absolute) |
Min Avg DP Abs |
The system will validate that the DP historical average for a specified record span does not go below a minimum threshold value. Records failing validation will generate an exception. Note: Differential Pressure values of null or zero (0) will not trigger exceptions. |
Specify the Severity, Data quality, a Minimum threshold value, the # of records to consider, and Units to use See Notes below. |
|
Frozen Value... validation rules: The system will validate that a field device is not incorrectly reporting the same value for a specified period of time. A device repeatedly reporting the same value will be considered frozen. |
|||
|
Frozen Value - Diff Pressure (Absolute) |
FrzVal DP Abs |
The system will validate that a field device data remains within an absolute tolerance range for the specified number of records to be considered frozen. Records failing validation will generate an exception. Note: Differential Pressure values of null or zero (0) will not trigger exceptions. |
Specify the Severity, Data quality, a +/- absolute tolerance range, the # of records over which the value needs to remain the same to be considered frozen, and Units to use See Notes below. |
|
Frozen Value - Energy (Absolute) |
FrzVal Energy Abs |
||
|
Frozen Value - Mass (Absolute) |
FrzVal Mass Abs |
||
|
Frozen Value - Static Pressure (Absolute) |
FrzVal SP Abs |
||
|
Frozen Value - Temperature (Absolute) |
FrzVal Temp Abs |
||
|
Frozen Value - Volume (Absolute) |
FrzVal Vol Abs |
||
|
Frozen Value - Diff Pressure (Percentage) |
FrzVal DP Pct |
The system will validate that a field device data remains within a percentage tolerance range for the specified number of records to be considered frozen. Records failing validation will generate an exception. Note: Differential Pressure values of null or zero (0) will not trigger exceptions. |
Specify the Severity, Data quality, a +/- percentage tolerance range, and the # of records over which the value needs to remain the same to be considered frozen See Notes below. |
|
Frozen Value - Energy (Percentage) |
FrzVal Energy Pct |
||
|
Frozen Value - Mass (Percentage) |
FrzVal Mass Pct |
||
|
Frozen Value - Static Pressure (Percentage) |
FrzVal SP Pct |
||
|
Frozen Value - Temperature (Percentage) |
FrzVal Temp Pct |
||
|
Frozen Value - Volume (Percentage) |
FrzVal Vol Pct |
||
Notes:
The # of records value means the number of contiguous records prior to the one that currently arrived for validation. If a device supports hourly data, then one hour equals one record. If the PM History span is one hour, and you want to specify an average of one day worth of data, specify "24" and the system will calculate an average of the last 24 records prior to the existing one. This number cannot be "0": a value of zero (0) generates a validation exception for every history record in the date range.
The +/- value defines the absolute or percentage tolerance range. This number cannot be "0": a value of zero (0) generates a validation exception for every history record in the date range. The exception is DP: for Differential Pressure, null or zero (0) tolerance values will not trigger exceptions.
The following table lists the available validation rule types for job records, and each rule's configuration options.
|
Rule Type |
Default Rule Name |
Description |
Configuration Options |
|---|---|---|---|
|
Calibration Drift Threshold... validation rules: The system will validate the value of the selected job calibration item, over the specified set of contiguous calibration jobs, to determine if the set is within the high/low limit specified; otherwise (if the entire set exceeds the limit) the set of values is considered "out of range" and will trigger the exception process. |
|||
|
Calibration Drift Threshold - Diff Pressure High (Percentage) |
Calib Drift DP High |
The system will validate that the change in calibration data values is within the defined high drift threshold (by percentage) for the specified number of contiguous calibration jobs. Records failing validation will generate an exception. |
Specify a High (percentage) drift tolerance, and the # of records to consider See Notes below. |
|
Calibration Drift Threshold - Static Pressure High (Percentage) |
Calib Drift SP High |
||
|
Calibration Drift Threshold - Temperature High (Percentage) |
Calib Drift T High |
||
|
Calibration Drift Threshold - Diff Pressure Low (Percentage) |
Calib Drift DP Low |
The system will validate that the change in calibration data values is within the defined low drift threshold (by percentage) for the specified number of contiguous calibration jobs. Records failing validation will generate an exception. |
Specify a Low (percentage) drift tolerance, and the # of records to consider See Notes below. |
|
Calibration Drift Threshold - Static Pressure Low (Percentage) |
Calib Drift SP Low |
||
|
Calibration Drift Threshold - Temperature Low (Percentage) |
Calib Drift T Low |
||
|
Calibration Drift Range... validation rules: The system will validate the value of the selected job calibration item, over the specified set of contiguous calibration jobs, to determine if the set is within the drift range specified; otherwise (if the entire set is outside the range) the value will be considered "out of range" and will trigger the exception process. |
|||
|
Calibration Drift Range - Diff Pressure (Percentage) |
Calib Range DP |
The system will validate that the change in calibration data values is within the defined drift range (by percentage) for the specified number of contiguous calibration jobs. Records failing validation will generate an exception. |
Specify a +/- range for the drift tolerance, and the # of records to consider See Notes below. |
|
Calibration Drift Range - Static Pressure (Percentage) |
Calib Range SP |
||
|
Calibration Drift Range - Temperature (Percentage) |
Calib Range T |
||
|
Number of Calibration Points... validation rules: The system will validate the number of calibration points present for the selected job and data type, to determine if the number in the report matches the value specified; otherwise the value will trigger the exception process. |
|||
|
Number of Calibration Points - Diff Pressure |
# Calib Points DP |
The system will validate that the number of calibration points present in the job report matches the specified value. Records failing validation will generate an exception. |
Specify the Number of points expected to be present |
|
Number of Calibration Points - Static Pressure |
# Calib Points SP |
||
|
Number of Calibration Points - Temperature |
# Calib Points Temp |
||
Notes:
The High or Low drift threshold value defines the change tolerance by percentage. If this number is zero (0), the system detects drifts in value (either high or low, as applicable) and generates a validation exception when all (either high or low) records in the set are not of identical value.
The # of records value means the number of contiguous calibration jobs including the one that currently arrived for validation, therefore the value cannot be zero (0). In the event that a calibration test point value standard has been changed within the contiguous record range specified, the values will be ignored (no exceptions generated) until the specified number of calibration report records is generated within the span of the new point value standard.
The +/- value defines the tolerance range by percentage. If this number is zero (0), the system detects any drift in value and generates a validation exception when all records in the set are not of identical value.
The following table lists the available validation rule types for a single gas station record, and each rule's configuration options.
|
Rule Type |
Default Rule Name |
Description |
Configuration Options |
|---|---|---|---|
|
Dynamic Station Run Ratio |
StaRun Dyn Ratio |
The system will validate that the contributed volume of any single run does not vary from the percentage of the base run, beyond a specified percentage range tolerance. Records failing validation will generate an exception. Note: Typically a run is configured with a single meter assigned. Although multiple meters can be assigned to a run, the subsequent meters are used as check devices. Only the first meter is used for purposes of validating the station run ratio. |
Specify the Severity, Data quality, and a +/- range for the tolerance, expressed as a percentage value (%) Default value is 0 % Note: The percentage you specify is relative to the volume of the base run. |
|
Linked Station Comparison... validation rules: The system will validate that volume, energy, or mass values do not differ between linked stations within the specified tolerance range. Note: The station to which any Linked Station validation rule applies must be configured with a linked station. This is true for any Node to which the rule is assigned. |
|||
|
Linked Station Comparison - Energy (Absolute) |
LStaComp Energy Abs |
The system will validate that the data values do not differ between linked stations within the specified absolute tolerance range. Records failing validation will generate an exception. |
Specify the Severity, Data quality, a +/- range for the tolerance, and Units to use |
|
Linked Station Comparison - Mass (Absolute) |
LStaComp Mass Abs |
||
|
Linked Station Comparison - Volume (Absolute) |
LStaComp Vol Abs |
||
|
Linked Station Comparison - Energy (Percentage) |
LStaComp Energy Pct |
The system will validate that the data values do not differ between linked stations within the specified percentage tolerance range. Records failing validation will generate an exception. |
Specify the Severity, Data quality, and a +/- percentage range for the tolerance |
|
Linked Station Comparison - Mass (Percentage) |
LStaComp Mass Pct |
||
|
Linked Station Comparison - Volume (Percentage) |
LStaComp Vol Pct |
||
|
Station Run Comparison... validation rules: The system will validate that pressure or temperature values for devices in a station do not differ within the specified tolerance range. |
|||
|
Station Run Comparison - Static Pressure (Absolute) |
StaRun Comp Press |
The system will validate that the pressure for devices in a station does not differ beyond the specified absolute tolerance. Records failing validation will generate an exception. |
Specify the Severity, Data quality, a Greater than value for the tolerance, and Units to use |
|
Station Run Comparison - Temperature (Absolute) |
StaRun Comp Temp |
The system will validate that the temperature for devices in a station does not differ beyond the specified absolute tolerance. Records failing validation will generate an exception. |
Specify the Severity, Data quality, a Greater than value for the tolerance, and Units to use |
|
|
|
